Skip to content

docs: add verified researcher quickstart - #96

Merged
Brad-Edwards merged 2 commits into
devfrom
23-researcher-quickstart
Aug 19, 2026
Merged

docs: add verified researcher quickstart#96
Brad-Edwards merged 2 commits into
devfrom
23-researcher-quickstart

Conversation

@Brad-Edwards

Copy link
Copy Markdown
Collaborator

Summary

Make the repository front door researcher-first with a closed, machine-checked CAGE-2 conformance quickstart that runs from the installed distribution and states exactly what its evidence does and does not establish.

Requirement UIDs

  • (none — bug/refactor/maintenance run; see Traceability section below)

Related Issues

Closes #23

ADR Impact

  • ADR-021

Changes

  • Rewrite the README around the verified installed-distribution quickstart, bounded expected output, artifact locations, claim levels, supported evidence, limitations, and researcher controls.
  • Add researcher and maintainer documentation paths while keeping contributor, build, release, governance, and repository mechanics outside the main reader flow.
  • Add a closed quickstart contract checker and exercise it against built and published distributions without shell execution or path escape.
  • Strengthen project-service governance tests with negative fixtures and behavior-level Nox log-suppression coverage.

Test Plan

  • Unit tests pass
  • Integration tests pass if applicable
  • Configured completion command passes
  • No coverage regression

15 focused tool tests pass. The post-fix completion and policy gates passed, and the publish boundary reran the canonical verification graph plus policy checks on the synchronized tree.

Ground Control Checks

  • Configured repository policy command passes
  • Pre-push code review and test-quality review completed; all findings fixed or dispositioned

Traceability

  • IMPLEMENTS: (none — bug/refactor/maintenance run)
  • TESTS: (none — documentation/configuration/structural-invariant run)

Checklist

  • Code follows the project's coding standards
  • Changelog: owned by Release Please (generated from the Conventional Commit PR title; no per-PR fragment)
  • Architectural docs updated if stack, package structure, or key behaviors changed

Documentation

Updated: see diff.

@Brad-Edwards
Brad-Edwards merged commit 97404ab into dev Aug 19, 2026
13 checks passed
@Brad-Edwards
Brad-Edwards deleted the 23-researcher-quickstart branch August 19, 2026 03:27
@Brad-Edwards
Brad-Edwards restored the 23-researcher-quickstart branch August 19, 2026 03:27
@Brad-Edwards
Brad-Edwards deleted the 23-researcher-quickstart branch August 19, 2026 03:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant